<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>pybind_external_overload_docs | My Python Project</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">My Python Project</a>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          pybind_external_overload_docs <span class="m-thin">module</span>
        </h1>
        <p>pybind11 external overload docs</p>
        <div class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#classes">Classes</a></li>
                <li><a href="#functions">Functions</a></li>
              </ul>
            </li>
          </ul>
        </div>
        <section id="classes">
          <h2><a href="#classes">Classes</a></h2>
          <dl class="m-doc">
            <dt>class <a href="pybind_external_overload_docs.Class.html" class="m-doc">Class</a></dt>
            <dd>My fun class!</dd>
          </dl>
        </section>
        <section id="functions">
          <h2><a href="#functions">Functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#foo-0a6d7" class="m-doc">foo</a>(</span><span class="m-doc-wrap">a: int,
              b: typing.Tuple[int, str]) -&gt; None</span>
            </dt>
            <dd>First overload</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#foo-515df" class="m-doc">foo</a>(</span><span class="m-doc-wrap">arg0: typing.Callable[[float, typing.List[float]], int]<span class="m-text m-dim">, /</span>) -&gt; None</span>
            </dt>
            <dd>Second overload</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#foo-34424" class="m-doc">foo</a>(</span><span class="m-doc-wrap">name: str) -&gt; None</span>
            </dt>
            <dd>Third overload</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#foo-46f8a" class="m-doc">foo</a>(</span><span class="m-doc-wrap">param: int = 4) -&gt; None</span>
            </dt>
            <dd>Fourth overload</dd>
            <dt id="foo-46f8a">
              <span class="m-doc-wrap-bumper">def <a href="#foo-46f8a" class="m-doc-self">foo</a>(</span><span class="m-doc-wrap">first: int) -&gt; None</span>
            </dt>
            <dd>This will produce param documentation mismatch warnings</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="foo-0a6d7"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def pybind_external_overload_docs.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#foo-0a6d7" class="m-doc-self">foo</a>(</span><span class="m-doc-wrap">a: int,
              b: typing.Tuple[int, str]) -&gt; None</span></span>
            </h3>
            <p>First overload</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>First parameter</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td>Second parameter</td>
                </tr>
              </tbody>
            </table>
<p>Details for the first overload.</p>
          </div></section>
          <section class="m-doc-details" id="foo-515df"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def pybind_external_overload_docs.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#foo-515df" class="m-doc-self">foo</a>(</span><span class="m-doc-wrap">arg0: typing.Callable[[float, typing.List[float]], int]<span class="m-text m-dim">, /</span>) -&gt; None</span></span>
            </h3>
            <p>Second overload</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">arg0</td>
                  <td>The caller</td>
                </tr>
              </tbody>
            </table>
<p>Complex signatures in the second overload should be matched properly, too.</p>
          </div></section>
          <section class="m-doc-details" id="foo-34424"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def pybind_external_overload_docs.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#foo-34424" class="m-doc-self">foo</a>(</span><span class="m-doc-wrap">name: str) -&gt; None</span></span>
            </h3>
            <p>Third overload</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">name</td>
                  <td>Ha!</td>
                </tr>
              </tbody>
            </table>
<p>This is a generic documentation and will be caught only by the third
overload. Luckily we just document that exact parameter.</p>
          </div></section>
          <section class="m-doc-details" id="foo-46f8a"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def pybind_external_overload_docs.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#foo-46f8a" class="m-doc-self">foo</a>(</span><span class="m-doc-wrap">param: int = 4) -&gt; None</span></span>
            </h3>
            <p>Fourth overload</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">param</td>
                  <td>This has a default value of 4 but that shouldn't be part of
the signature.</td>
                </tr>
              </tbody>
            </table>
<p>Fourth overload has a default value.</p>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
</body>
</html>
